tests/phpunit/includes/changes/RCCacheEntryFactoryTest.php

   1 <?php
   2
   3 use MediaWiki\Linker\LinkRenderer;
   4 use MediaWiki\MediaWikiServices;
   5
   6 /**
   7  * @covers RCCacheEntryFactory
   8  *
   9  * @group Database
  10  *
  11  * @author Katie Filbert < aude.wiki@gmail.com >
  12  */
  13 class RCCacheEntryFactoryTest extends MediaWikiLangTestCase {
  14
  15         /**
  16          * @var TestRecentChangesHelper
  17          */
  18         private $testRecentChangesHelper;
  19
  20         /**
  21          * @var LinkRenderer;
  22          */
  23         private $linkRenderer;
  24
  25         public function __construct( $name = null, array $data = [], $dataName = '' ) {
  26                 parent::__construct( $name, $data, $dataName );
  27
  28                 $this->testRecentChangesHelper = new TestRecentChangesHelper();
  29         }
  30
  31         protected function setUp() {
  32                 parent::setUp();
  33
  34                 $this->setMwGlobals( [
  35                         'wgArticlePath' => '/wiki/$1'
  36                 ] );
  37
  38                 $this->linkRenderer = new LinkRenderer(
  39                         MediaWikiServices::getInstance()->getTitleFormatter()
  40                 );
  41         }
  42
  43         public function testNewFromRecentChange() {
  44                 $user = $this->getMutableTestUser()->getUser();
  45                 $recentChange = $this->testRecentChangesHelper->makeEditRecentChange(
  46                         $user,
  47                         'Xyz',
  48                         5, // curid
  49                         191, // thisid
  50                         190, // lastid
  51                         '20131103212153',
  52                         0, // counter
  53                         0 // number of watching users
  54                 );
  55                 $cacheEntryFactory = new RCCacheEntryFactory(
  56                         $this->getContext(),
  57                         $this->getMessages(),
  58                         $this->linkRenderer
  59                 );
  60                 $cacheEntry = $cacheEntryFactory->newFromRecentChange( $recentChange, false );
  61
  62                 $this->assertInstanceOf( 'RCCacheEntry', $cacheEntry );
  63
  64                 $this->assertEquals( false, $cacheEntry->watched, 'watched' );
  65                 $this->assertEquals( '21:21', $cacheEntry->timestamp, 'timestamp' );
  66                 $this->assertEquals( 0, $cacheEntry->numberofWatchingusers, 'watching users' );
  67                 $this->assertEquals( false, $cacheEntry->unpatrolled, 'unpatrolled' );
  68
  69                 $this->assertUserLinks( $user->getName(), $cacheEntry );
  70                 $this->assertTitleLink( 'Xyz', $cacheEntry );
  71
  72                 $diff = [ 'curid' => 5, 'diff' => 191, 'oldid' => 190 ];
  73                 $cur = [ 'curid' => 5, 'diff' => 0, 'oldid' => 191 ];
  74                 $this->assertQueryLink( 'cur', $cur, $cacheEntry->curlink, 'cur link' );
  75                 $this->assertQueryLink( 'prev', $diff, $cacheEntry->lastlink, 'prev link' );
  76                 $this->assertQueryLink( 'diff', $diff, $cacheEntry->difflink, 'diff link' );
  77         }
  78
  79         public function testNewForDeleteChange() {
  80                 $expected = [
  81                         'title' => 'Abc',
  82                         'user' => 'TestRecentChangesUser',
  83                         'timestamp' => '21:21',
  84                         'numberofWatchingusers' => 0,
  85                         'unpatrolled' => false
  86                 ];
  87                 $user = $this->getMutableTestUser()->getUser();
  88                 $recentChange = $this->testRecentChangesHelper->makeLogRecentChange(
  89                         'delete',
  90                         'delete',
  91                         $user,
  92                         'Abc',
  93                         '20131103212153',
  94                         0, // counter
  95                         0 // number of watching users
  96                 );
  97                 $cacheEntryFactory = new RCCacheEntryFactory(
  98                         $this->getContext(),
  99                         $this->getMessages(),
 100                         $this->linkRenderer
 101                 );
 102                 $cacheEntry = $cacheEntryFactory->newFromRecentChange( $recentChange, false );
 103
 104                 $this->assertInstanceOf( 'RCCacheEntry', $cacheEntry );
 105
 106                 $this->assertEquals( false, $cacheEntry->watched, 'watched' );
 107                 $this->assertEquals( '21:21', $cacheEntry->timestamp, 'timestamp' );
 108                 $this->assertEquals( 0, $cacheEntry->numberofWatchingusers, 'watching users' );
 109                 $this->assertEquals( false, $cacheEntry->unpatrolled, 'unpatrolled' );
 110
 111                 $this->assertDeleteLogLink( $cacheEntry );
 112                 $this->assertUserLinks( $user->getName(), $cacheEntry );
 113
 114                 $this->assertEquals( 'cur', $cacheEntry->curlink, 'cur link for delete log or rev' );
 115                 $this->assertEquals( 'diff', $cacheEntry->difflink, 'diff link for delete log or rev' );
 116                 $this->assertEquals( 'prev', $cacheEntry->lastlink, 'pref link for delete log or rev' );
 117         }
 118
 119         public function testNewForRevUserDeleteChange() {
 120                 $user = $this->getMutableTestUser()->getUser();
 121                 $recentChange = $this->testRecentChangesHelper->makeDeletedEditRecentChange(
 122                         $user,
 123                         'Zzz',
 124                         '20131103212153',
 125                         191, // thisid
 126                         190, // lastid
 127                         '20131103212153',
 128                         0, // counter
 129                         0 // number of watching users
 130                 );
 131                 $cacheEntryFactory = new RCCacheEntryFactory(
 132                         $this->getContext(),
 133                         $this->getMessages(),
 134                         $this->linkRenderer
 135                 );
 136                 $cacheEntry = $cacheEntryFactory->newFromRecentChange( $recentChange, false );
 137
 138                 $this->assertInstanceOf( 'RCCacheEntry', $cacheEntry );
 139
 140                 $this->assertEquals( false, $cacheEntry->watched, 'watched' );
 141                 $this->assertEquals( '21:21', $cacheEntry->timestamp, 'timestamp' );
 142                 $this->assertEquals( 0, $cacheEntry->numberofWatchingusers, 'watching users' );
 143                 $this->assertEquals( false, $cacheEntry->unpatrolled, 'unpatrolled' );
 144
 145                 $this->assertRevDel( $cacheEntry );
 146                 $this->assertTitleLink( 'Zzz', $cacheEntry );
 147
 148                 $this->assertEquals( 'cur', $cacheEntry->curlink, 'cur link for delete log or rev' );
 149                 $this->assertEquals( 'diff', $cacheEntry->difflink, 'diff link for delete log or rev' );
 150                 $this->assertEquals( 'prev', $cacheEntry->lastlink, 'pref link for delete log or rev' );
 151         }
 152
 153         private function assertUserLinks( $user, $cacheEntry ) {
 154                 $this->assertTag(
 155                         [
 156                                 'tag' => 'a',
 157                                 'attributes' => [
 158                                         'class' => 'new mw-userlink'
 159                                 ],
 160                                 'content' => $user
 161                         ],
 162                         $cacheEntry->userlink,
 163                         'verify user link'
 164                 );
 165
 166                 $this->assertTag(
 167                         [
 168                                 'tag' => 'span',
 169                                 'attributes' => [
 170                                         'class' => 'mw-usertoollinks'
 171                                 ],
 172                                 'child' => [
 173                                         'tag' => 'a',
 174                                         'content' => 'talk',
 175                                 ]
 176                         ],
 177                         $cacheEntry->usertalklink,
 178                         'verify user talk link'
 179                 );
 180
 181                 $this->assertTag(
 182                         [
 183                                 'tag' => 'span',
 184                                 'attributes' => [
 185                                         'class' => 'mw-usertoollinks'
 186                                 ],
 187                                 'child' => [
 188                                         'tag' => 'a',
 189                                         'content' => 'contribs',
 190                                 ]
 191                         ],
 192                         $cacheEntry->usertalklink,
 193                         'verify user tool links'
 194                 );
 195         }
 196
 197         private function assertDeleteLogLink( $cacheEntry ) {
 198                 $this->assertTag(
 199                         [
 200                                 'tag' => 'a',
 201                                 'attributes' => [
 202                                         'href' => '/wiki/Special:Log/delete',
 203                                         'title' => 'Special:Log/delete'
 204                                 ],
 205                                 'content' => 'Deletion log'
 206                         ],
 207                         $cacheEntry->link,
 208                         'verify deletion log link'
 209                 );
 210         }
 211
 212         private function assertRevDel( $cacheEntry ) {
 213                 $this->assertTag(
 214                         [
 215                                 'tag' => 'span',
 216                                 'attributes' => [
 217                                         'class' => 'history-deleted'
 218                                 ],
 219                                 'content' => '(username removed)'
 220                         ],
 221                         $cacheEntry->userlink,
 222                         'verify user link for change with deleted revision and user'
 223                 );
 224         }
 225
 226         private function assertTitleLink( $title, $cacheEntry ) {
 227                 $this->assertTag(
 228                         [
 229                                 'tag' => 'a',
 230                                 'attributes' => [
 231                                         'href' => '/wiki/' . $title,
 232                                         'title' => $title
 233                                 ],
 234                                 'content' => $title
 235                         ],
 236                         $cacheEntry->link,
 237                         'verify title link'
 238                 );
 239         }
 240
 241         private function assertQueryLink( $content, $params, $link ) {
 242                 $this->assertTag(
 243                         [
 244                                 'tag' => 'a',
 245                                 'content' => $content
 246                         ],
 247                         $link,
 248                         'assert query link element'
 249                 );
 250
 251                 foreach ( $params as $key => $value ) {
 252                         $this->assertRegExp( '/' . $key . '=' . $value . '/', $link, "verify $key link params" );
 253                 }
 254         }
 255
 256         private function getMessages() {
 257                 return [
 258                         'cur' => 'cur',
 259                         'diff' => 'diff',
 260                         'hist' => 'hist',
 261                         'enhancedrc-history' => 'history',
 262                         'last' => 'prev',
 263                         'blocklink' => 'block',
 264                         'history' => 'Page history',
 265                         'semicolon-separator' => '; ',
 266                         'pipe-separator' => ' | '
 267                 ];
 268         }
 269
 270         private function getContext() {
 271                 $user = $this->getMutableTestUser()->getUser();
 272                 $context = $this->testRecentChangesHelper->getTestContext( $user );
 273
 274                 $title = Title::newFromText( 'RecentChanges', NS_SPECIAL );
 275                 $context->setTitle( $title );
 276
 277                 return $context;
 278         }
 279 }